Skip to content

docs: fix documentation drift — missing every N weeks in schedule-syntax reference#490

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-schedule-syntax-every-n-weeks-be750f09c9f3004b
May 10, 2026
Merged

docs: fix documentation drift — missing every N weeks in schedule-syntax reference#490
jamesadevine merged 1 commit into
mainfrom
docs/fix-schedule-syntax-every-n-weeks-be750f09c9f3004b

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
Schedule syntax every N weeks format is supported by the parser but absent from the dedicated reference doc docs/schedule-syntax.md

Details

The fuzzy_schedule.rs parser accepts every N weeks (e.g., every 2 weeks), converting it to N×7 days. This syntax is correctly documented in:

  • README.md (schedule: every 2 weeks # Every 14 days at scattered time)
  • prompts/create-ado-agentic-workflow.md (| every 2 weeks | Every N weeks (converted to N×7 days) |)

However, docs/schedule-syntax.md — the dedicated reference page for schedule syntax — was missing this format from its "Special Periods" section. An agent or contributor consulting only this reference doc would not discover the supported format.

Applied Fixes

  • Added every N weeks to the "Special Periods" section of docs/schedule-syntax.md, matching the description used in README and the authoring prompt

This pull request was created by the automated documentation freshness check.

Generated by Documentation Freshness Check · ● 4.8M ·

The fuzzy_schedule.rs parser supports 'every N weeks' (converted to
N×7 days), which is documented in README.md and
prompts/create-ado-agentic-workflow.md, but was absent from the
dedicated docs/schedule-syntax.md reference under Special Periods.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine marked this pull request as ready for review May 10, 2026 05:05
@jamesadevine jamesadevine merged commit 5a99824 into main May 10, 2026
@jamesadevine jamesadevine deleted the docs/fix-schedule-syntax-every-n-weeks-be750f09c9f3004b branch May 10, 2026 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant